There are some very notable changes in this version. They had to be made in order to accommodate compiling for both the WSAPI and the AppleEvent driven CGIs from a single code set.
Memory
You must not make any direct memory allocation/deallocation calls in your code. This includes NewHandle/Ptr, DisposeHandle/Ptr, malloc, free, etc. SetHandleSize should be safe if you don't grow your handles by much, or only use the handle for a very short period.
Within the CustomCGI functions, you may only use these functions to allocate memory:
CGINewHandle, CGINewHandleClear, CGINewPtr, CGINewPtrClear, CGIDisposeHandle and CGIDisposePtr. These functions must all be passed theCGIHdl that the CustomCGI functions receive.
Within all other custom code use the functions:
MemoryNewHandle, MemoryNewHandleClear, MemoryNewPtr and MemoryNewPtrClear and the new functions MemoryDisposeHandle and MemoryDisposePtr.
These are all functionally equivelant to the Mac Toolbox calls: NewHandle, NewHandleClear, NewPtr, NewPtrClear, DisposeHandle and DisposePtr. However, they involve some extra 'protective wrapping' to ensure memory is handled smoothly.
Logging
The function 'LogWriteEntry' is now the only log call that you can use when compiling as a WSAPI plug-in. It will put a newline character at the end of the string passed to it.
All other Logging calls are not supported and may go away in a future version of the framework.
The new function 'DisplayString' displays a string to the status window (of the server if using WSAPI). Currently it does nothing when compiling as a CGI (but it will in the future when a status window is added to the framework).
Interface
Caution must be taken to ensure that no interface calls are made when compiling as a plug-in. If you want something like a preferences interface, you'll have to generate a separate configuration application (which can also be done with the framework).
If you must include interface code in the custom handlers that are used for plug-ins (which you shouldn't do since no interface calls should be made from any but the custom interface functions), wrap it in:
#if !(kCompilingForWSAPI)
...
#endif
so it won't be included when you compile as a plug-in.
Resources
Keep all of the resources that will not be included in a plug-in (especially interface resources) in the "MyInterface.rsrc" and keep only the resources shared by both the plug-in and application versions of the cgi in the file "MyCustom.rsrc".
____________________
StarNine, and WebSTAR are trademarks of StarNine Technologies, Inc.
Grant's CGI Framework is a trademark of Grant Neufeld.
